/*
 * Copyright (C) 2012 Caldia Apps.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.caldia.android.frameworkG1.controller;

/**
 * 画面遷移管理
 * 
 * @author k-matsuda@caldia.org
 * 
 */
public interface ITransitionManager extends IActivityManager {

	/**
	 * 次に表示するフラグメントの有無
	 * 
	 * @param currentNo
	 *            表示中アクティビティ、フラグメント番号
	 * @param logNo
	 *            トラッキング用番号
	 * @return ある場合は true を返す
	 */
	boolean hasNextFragment(final int currentNo, final int logNo);

	/**
	 * 次に表示する画面の有無
	 * 
	 * @param currentNo
	 *            表示中アクティビティ、フラグメント番号
	 * @param logNo
	 *            トラッキング用番号
	 * @return ある場合は true を返す
	 */
	boolean hasNextActivity(final int currentNo, final int logNo);

	/**
	 * 戻り先フラグメントの有無
	 * 
	 * @param currentNo
	 *            表示中のアクティビティ、フラグメント番号
	 * @param logNo
	 *            トラッキング用番号
	 * @return ある場合は true を返す
	 */
	boolean hasPreviousFragment(final int currentNo, final int logNo);

	/**
	 * 戻り先アクティビティの有無
	 * 
	 * @param currentNo
	 *            表示中アクティビティ、フラグメント番号
	 * @param logNo
	 *            トラッキング用番号
	 * @return ある場合は true を返す
	 */
	boolean hasPreviousActivity(final int currentNo, final int logNo);

	/**
	 * 次の画面に遷移する
	 * 
	 * @param currentNo
	 *            表示中のアクティビティ、フラグメント番号
	 * @param l
	 *            リスナー
	 * @param logNo
	 *            トラッキング用番号
	 */
	void moveToNextActivity(final int currentNo, final ControllerListener l,
			final int logNo);

	/**
	 * 前の画面に遷移する
	 * 
	 * @param currentNo
	 *            表示中のアクティビティ、フラグメント番号
	 * @param l
	 *            リスナー
	 * @param logNo
	 *            トラッキング用番号
	 * @return 前の画面が無かった場合は false を返す
	 */
	void moveToPreviousActivity(final int currentNo,
			final ControllerListener l, final int logNo);

	/**
	 * 次に遷移するアクティビティ、フラグメント番号を設定する
	 * 
	 * @param currentNo
	 *            遷移元画面番号
	 * @param nextNo
	 *            遷移先画面番号
	 * @param logNo
	 *            トラッキング用番号
	 */
	void setNextTrasition(final int currentNo, final int nextNo, final int logNo);

	/**
	 * 戻り先アクティビティ、フラグメント番号を設定する
	 * 
	 * @param currentNo
	 *            遷移元画面番号
	 * @param previousNo
	 *            遷移先画面番号
	 * @param logNo
	 *            トラッキング用番号
	 */
	void setPrevioutTrasiton(final int currentNo, final int previousNo,
			final int logNo);

	/**
	 * モード独自の画面制御用クラスを登録する
	 * 
	 * @param modeNo
	 *            モード番号
	 * @param modeManager
	 *            モード管理マネージャ
	 * @param logNo
	 *            トラッキング用番号
	 */
	void addModeManager(final int modeNo,
			final Class<? extends ModeManager> modeManager, final int logNo);

	/**
	 * モード独自の画面制御用クラスを取得する
	 * 
	 * @param modeNo
	 *            モード番号
	 * @param logNo
	 *            トラッキング用番号
	 * @return 存在し無い場合は null を返す
	 */
	ModeManager getModeManager(final int modeNo, final int logNo);

	/**
	 * モード番号を取得する
	 * 
	 * @param modeManager
	 *            モード管理クラス
	 * @param logNo
	 *            トラッキング用番号
	 * @return 存在しない場合は null を返す
	 */
	int getModeNo(final Class<? extends ModeManager> modeManager,
			final int logNo);

	/**
	 * 画面作成イベント送信
	 * 
	 * @param obj
	 *            画面インスタンス
	 */
	void sendOnCreateMessage(final Object obj);

	/**
	 * 画面リジュームイベント送信
	 * 
	 * @param obj
	 *            画面インスタンス
	 */
	void sendOnResumeMessage(final Object obj);

	/**
	 * 画面ストップイベント送信
	 * 
	 * @param obj
	 *            画面インスタンス
	 */
	void sendOnStopMessage(final Object obj);

	/**
	 * 画面終了イベント送信
	 * 
	 * @param obj
	 *            画面インスタンス
	 */
	void sendOnDestroyMessage(final Object obj);

}
